/config/system/interface/<intf_name>/description

Create a description for the interface.

Use

Use to create a description of the interface type, use, and any other information to identify the interface. Enter a maximum of 255 characters.

Parameters

intf_name: Name of interface

Data Key

The data key contains the description.

Data Type

string

Default Data Value

“”

Default Allowed

False

Request Methods

GET, PUT

Examples

GET

curl -b cookie.jar -k https://10.1.2.3:8443/lrs/api/v1.0/config/system/interface/em1/description

GET Response

{"/config/system/interface/em1/description": {"data": "",
                                               "default": False,
                                               "defaultAllowed": False,
                                               "deleteAllowed": False,
                                               "numChildren": 0,
                                               "type": "string"},
 "httpResponseCode": 200,
 "recurse": False,
 "requestPath": "/config/system/interface/em1/description"}

PUT

curl -b cookie.jar –data @data.json -k -H “Content-Type: application/json” -X PUT https://10.1.2.3:8443/lrs/api/v1.0/config/system/interface/em1/description

PUT Response

{"httpResponseCode": 200,
  "requestPath": "/config/system/interface/em1/description",
  "recurse":false}
  1. /config/system/interface/<intf_name>/description 1. Parameters 2. Data Key
    1. Data Type
    2. Default Data Value 3. Default Allowed 4. Request Methods 5. Related 6. Examples